Skip to content

docs: add RELEASING.md#29

Merged
bm1549 merged 4 commits into
mainfrom
brian.marks/add-releasing-doc
May 8, 2026
Merged

docs: add RELEASING.md#29
bm1549 merged 4 commits into
mainfrom
brian.marks/add-releasing-doc

Conversation

@bm1549
Copy link
Copy Markdown
Contributor

@bm1549 bm1549 commented May 8, 2026

Summary

  • Adds RELEASING.md documenting the manual release process (prereqs, release commands, verification).
  • Links to it from README.md under a new "Releasing" section.

The runbook publishes to npm before pushing the version tag so a failed npm publish doesn't leave the repo advertising a tag that points at no published version, and includes npm publish --dry-run as a sanity check before the real publish.

Test plan

  • Manual review of the steps in RELEASING.md against the repo's actual release pattern (npm-published versions match 0.1.X commits + v0.1.X tags).
  • Ran npm paack --dry-run to confirm REALEASING.md is not included, although README.md is still present (NPM does this)

🤖 Generated with Claude Code

Document the manual release process so any maintainer can cut a
release without needing to ask. Linked from the README.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@bm1549 bm1549 added documentation Improvements or additions to documentation semver-null Doesn't affect semver (e.g. tests, docs, CI) AI Generated Pull request was generated with AI assistance labels May 8, 2026
@bm1549 bm1549 marked this pull request as ready for review May 8, 2026 17:30
Copy link
Copy Markdown
Contributor

@bengl bengl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just the one nit.

Comment thread RELEASING.md Outdated

- Push access to `main` on this repository.
- The [`gh`](https://cli.github.com/) CLI, authenticated against `DataDog/dc-polyfill`.
- Logged in to an npm account with publish access to `dc-polyfill`. Check with `npm whoami`; run `npm login` if needed. If you don't have publish access, ask an existing maintainer.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Logged in to the npm account.

Comment thread RELEASING.md Outdated
bm1549 and others added 2 commits May 8, 2026 13:32
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Comment thread RELEASING.md Outdated
Copy link
Copy Markdown
Contributor

@bengl bengl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bm1549 bm1549 merged commit 87d038c into main May 8, 2026
43 checks passed
@bm1549 bm1549 deleted the brian.marks/add-releasing-doc branch May 8, 2026 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI Generated Pull request was generated with AI assistance documentation Improvements or additions to documentation semver-null Doesn't affect semver (e.g. tests, docs, CI)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants